<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
<!-- qtextlist.cpp -->
  <title>QTextList Class | Qt GUI 5.14.2</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td ><a href="../qtdoc/index.html">Qt 5.14</a></td><td ><a href="qtgui-index.html">Qt GUI</a></td><td ><a href="qtgui-module.html">C++ Classes</a></td><td >QTextList</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtgui-index.html">Qt 5.14.2 Reference Documentation</a></td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QTextList Class</h1>
<!-- $$$QTextList-brief -->
<p>The QTextList class provides a decorated list of items in a <a href="qtextdocument.html">QTextDocument</a>. <a href="#details">More...</a></p>
<!-- @@@QTextList -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QTextList&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += gui</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qtextblockgroup.html">QTextBlockGroup</a></td></tr></table></div><ul>
<li><a href="qtextlist-members.html">List of all members, including inherited members</a></li>
<li><a href="qtextlist-obsolete.html">Obsolete members</a></li>
</ul>
<p><b>Note:</b> All functions in this class are <a href="../qtdoc/threads-reentrancy.html">reentrant</a>.</p>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlist.html#add">add</a></b>(const QTextBlock &amp;<i>block</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextlist.html#count">count</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextListFormat </td><td class="memItemRight bottomAlign"><b><a href="qtextlist.html#format">format</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextBlock </td><td class="memItemRight bottomAlign"><b><a href="qtextlist.html#item">item</a></b>(int <i>i</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextlist.html#itemNumber">itemNumber</a></b>(const QTextBlock &amp;<i>block</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qtextlist.html#itemText">itemText</a></b>(const QTextBlock &amp;<i>block</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlist.html#remove">remove</a></b>(const QTextBlock &amp;<i>block</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlist.html#removeItem">removeItem</a></b>(int <i>i</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlist.html#setFormat">setFormat</a></b>(const QTextListFormat &amp;<i>format</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QTextList-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>A list contains a sequence of text blocks, each of which is marked with a bullet point or other symbol. Multiple levels of lists can be used, and the automatic numbering feature provides support for ordered numeric and alphabetical lists.</p>
<p>Lists are created by using a text cursor to insert an empty list at the current position or by moving existing text into a new list. The <a href="qtextcursor.html#insertList">QTextCursor::insertList</a>() function inserts an empty block into the document at the cursor position, and makes it the first item in a list.</p>
<pre class="cpp">

      <span class="type"><a href="qtextlistformat.html">QTextListFormat</a></span> listFormat;
      <span class="keyword">if</span> (list) {
          listFormat <span class="operator">=</span> list<span class="operator">-</span><span class="operator">&gt;</span>format();
          listFormat<span class="operator">.</span>setIndent(listFormat<span class="operator">.</span>indent() <span class="operator">+</span> <span class="number">1</span>);
      }

      listFormat<span class="operator">.</span>setStyle(<span class="type"><a href="qtextlistformat.html">QTextListFormat</a></span><span class="operator">::</span>ListDisc);
      cursor<span class="operator">.</span>insertList(listFormat);

</pre>
<p>The <a href="qtextcursor.html#createList">QTextCursor::createList</a>() function takes the contents of the cursor's current block and turns it into the first item of a new list.</p>
<p>The cursor's current list is found with <a href="qtextcursor.html#currentList">QTextCursor::currentList</a>().</p>
<p>The number of items in a list is given by <a href="qtextlist.html#count">count</a>(). Each item can be obtained by its index in the list with the <a href="qtextlist.html#item">item</a>() function. Similarly, the index of a given item can be found with <a href="qtextlist.html#itemNumber">itemNumber</a>(). The text of each item can be found with the <a href="qtextlist.html#itemText">itemText</a>() function.</p>
<p>Note that the items in the list may not be adjacent elements in the document. For example, the top-level items in a multi-level list will be separated by the items in lower levels of the list.</p>
<p>List items can be deleted by index with the <a href="qtextlist.html#removeItem">removeItem</a>() function. <a href="qtextlist.html#remove">remove</a>() deletes the specified item in the list.</p>
<p>The list's format is set with <a href="qtextlist.html#setFormat">setFormat</a>() and read with <a href="qtextlist.html#format">format</a>(). The format describes the decoration of the list itself, and not the individual items.</p>
</div>
<p><b>See also </b><a href="qtextblock.html">QTextBlock</a>, <a href="qtextlistformat.html">QTextListFormat</a>, and <a href="qtextcursor.html">QTextCursor</a>.</p>
<!-- @@@QTextList -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$add[overload1]$$$addconstQTextBlock& -->
<h3 class="fn" id="add"><a name="add"></a><span class="type">void</span> QTextList::<span class="name">add</span>(const <span class="type"><a href="qtextblock.html">QTextBlock</a></span> &amp;<i>block</i>)</h3>
<p>Makes the given <i>block</i> part of the list.</p>
<p><b>See also </b><a href="qtextlist.html#remove">remove</a>() and <a href="qtextlist.html#removeItem">removeItem</a>().</p>
<!-- @@@add -->
<!-- $$$count[overload1]$$$count -->
<h3 class="fn" id="count"><a name="count"></a><span class="type">int</span> QTextList::<span class="name">count</span>() const</h3>
<p>Returns the number of items in the list.</p>
<!-- @@@count -->
<!-- $$$format[overload1]$$$format -->
<h3 class="fn" id="format"><a name="format"></a><span class="type"><a href="qtextlistformat.html">QTextListFormat</a></span> QTextList::<span class="name">format</span>() const</h3>
<p>Returns the list's format.</p>
<p><b>See also </b><a href="qtextlist.html#setFormat">setFormat</a>().</p>
<!-- @@@format -->
<!-- $$$item[overload1]$$$itemint -->
<h3 class="fn" id="item"><a name="item"></a><span class="type"><a href="qtextblock.html">QTextBlock</a></span> QTextList::<span class="name">item</span>(<span class="type">int</span> <i>i</i>) const</h3>
<p>Returns the <i>i</i>-th text block in the list.</p>
<p><b>See also </b><a href="qtextlist.html#count">count</a>() and <a href="qtextlist.html#itemText">itemText</a>().</p>
<!-- @@@item -->
<!-- $$$itemNumber[overload1]$$$itemNumberconstQTextBlock& -->
<h3 class="fn" id="itemNumber"><a name="itemNumber"></a><span class="type">int</span> QTextList::<span class="name">itemNumber</span>(const <span class="type"><a href="qtextblock.html">QTextBlock</a></span> &amp;<i>block</i>) const</h3>
<p>Returns the index of the list item that corresponds to the given <i>block</i>. Returns -1 if the block was not present in the list.</p>
<!-- @@@itemNumber -->
<!-- $$$itemText[overload1]$$$itemTextconstQTextBlock& -->
<h3 class="fn" id="itemText"><a name="itemText"></a><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QTextList::<span class="name">itemText</span>(const <span class="type"><a href="qtextblock.html">QTextBlock</a></span> &amp;<i>block</i>) const</h3>
<p>Returns the text of the list item that corresponds to the given <i>block</i>.</p>
<!-- @@@itemText -->
<!-- $$$remove[overload1]$$$removeconstQTextBlock& -->
<h3 class="fn" id="remove"><a name="remove"></a><span class="type">void</span> QTextList::<span class="name">remove</span>(const <span class="type"><a href="qtextblock.html">QTextBlock</a></span> &amp;<i>block</i>)</h3>
<p>Removes the given <i>block</i> from the list.</p>
<p><b>See also </b><a href="qtextlist.html#add">add</a>() and <a href="qtextlist.html#removeItem">removeItem</a>().</p>
<!-- @@@remove -->
<!-- $$$removeItem[overload1]$$$removeItemint -->
<h3 class="fn" id="removeItem"><a name="removeItem"></a><span class="type">void</span> QTextList::<span class="name">removeItem</span>(<span class="type">int</span> <i>i</i>)</h3>
<p>Removes the item at item position <i>i</i> from the list. When the last item in the list is removed, the list is automatically deleted by the <a href="qtextdocument.html">QTextDocument</a> that owns it.</p>
<p><b>See also </b><a href="qtextlist.html#add">add</a>() and <a href="qtextlist.html#remove">remove</a>().</p>
<!-- @@@removeItem -->
<!-- $$$setFormat[overload1]$$$setFormatconstQTextListFormat& -->
<h3 class="fn" id="setFormat"><a name="setFormat"></a><span class="type">void</span> QTextList::<span class="name">setFormat</span>(const <span class="type"><a href="qtextlistformat.html">QTextListFormat</a></span> &amp;<i>format</i>)</h3>
<p>Sets the list's format to <i>format</i>.</p>
<p><b>See also </b><a href="qtextlist.html#format">format</a>().</p>
<!-- @@@setFormat -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2020 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>
